home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1992 June: ROMin Holiday / ADC Developer CD (1992-06) (''ROMin Holiday'')_iso / Developer Connection - 06-1992.iso / Developer Essentials / MPW Interfaces & Libraries / CIncludes / StandardFile.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-01-29  |  7.5 KB  |  261 lines  |  [TEXT/MPS ]
  1.  
  2. /************************************************************
  3.  
  4. Created: Sunday, September 15, 1991 at 8:56 PM
  5.  StandardFile.h
  6.  C Interface to the Macintosh Libraries
  7.  
  8.  
  9.   Copyright Apple Computer, Inc. 1990-1991
  10.   All rights reserved
  11.  
  12. ************************************************************/
  13.  
  14.  
  15. #ifndef __STANDARDFILE__
  16. #define __STANDARDFILE__
  17.  
  18. #ifndef __TYPES__
  19. #include <Types.h>
  20. #endif
  21.  
  22. #ifndef __DIALOGS__
  23. #include <Dialogs.h>
  24. #endif
  25.  
  26. #ifndef __FILES__
  27. #include <Files.h>
  28. #endif
  29.  
  30.  
  31. enum {
  32.  
  33.  
  34. /* resource IDs and item offsets of pre-7.0 dialogs */
  35.  putDlgID = -3999,
  36.  putSave = 1,
  37.  putCancel = 2,
  38.  putEject = 5,
  39.  putDrive = 6,
  40.  putName = 7,
  41.  
  42.  getDlgID = -4000,
  43.  getOpen = 1,
  44.  getCancel = 3,
  45.  getEject = 5,
  46.  getDrive = 6,
  47.  getNmList = 7,
  48.  getScroll = 8,
  49.  
  50. /* resource IDs and item offsets of 7.0 dialogs */
  51.  sfPutDialogID = -6043,
  52.  sfGetDialogID = -6042,
  53.  sfItemOpenButton = 1,
  54.  sfItemCancelButton = 2,
  55.  sfItemBalloonHelp = 3,
  56.  sfItemVolumeUser = 4,
  57.  sfItemEjectButton = 5
  58. };
  59. enum {
  60.  sfItemDesktopButton = 6,
  61.  sfItemFileListUser = 7,
  62.  sfItemPopUpMenuUser = 8,
  63.  sfItemDividerLinePict = 9,
  64.  sfItemFileNameTextEdit = 10,
  65.  sfItemPromptStaticText = 11,
  66.  sfItemNewFolderUser = 12,
  67.  
  68.  
  69. /* pseudo-item hits for use in DlgHook */
  70.  sfHookFirstCall = -1,
  71.  sfHookCharOffset = 0x1000,
  72.  sfHookNullEvent = 100,
  73.  sfHookRebuildList = 101,
  74.  sfHookFolderPopUp = 102,
  75.  sfHookOpenFolder = 103,
  76.  
  77.  
  78. /* the following are only in system 7.0+ */
  79.  sfHookOpenAlias = 104,
  80.  sfHookGoToDesktop = 105,
  81.  sfHookGoToAliasTarget = 106,
  82.  sfHookGoToParent = 107,
  83.  sfHookGoToNextDrive = 108,
  84.  sfHookGoToPrevDrive = 109,
  85.  sfHookChangeSelection = 110
  86. };
  87. enum {
  88.  sfHookSetActiveOffset = 200,
  89.  sfHookLastCall = -2
  90.  
  91. /* the refcon field of the dialog record during a
  92.  modalfilter or dialoghook contains one of the following */
  93.  
  94. #define sfMainDialogRefCon 'stdf'
  95. #define sfNewFolderDialogRefCon 'nfdr'
  96. #define sfReplaceDialogRefCon 'rplc'
  97. #define sfStatWarnDialogRefCon 'stat'
  98. #define sfLockWarnDialogRefCon 'lock'
  99. #define sfErrorDialogRefCon 'err '
  100. };
  101.  
  102. struct SFReply {
  103.  Boolean good;
  104.  Boolean copy;
  105.  OSType fType;
  106.  short vRefNum;
  107.  short version;
  108.  Str63 fName;
  109. };
  110.  
  111. typedef struct SFReply SFReply;
  112.  
  113. struct StandardFileReply {
  114.  Boolean sfGood;
  115.  Boolean sfReplacing;
  116.  OSType sfType;
  117.  FSSpec sfFile;
  118.  ScriptCode sfScript;
  119.  short sfFlags;
  120.  Boolean sfIsFolder;
  121.  Boolean sfIsVolume;
  122.  long sfReserved1;
  123.  short sfReserved2;
  124. };
  125.  
  126. typedef struct StandardFileReply StandardFileReply;
  127.  
  128.  
  129. typedef pascal short (*DlgHookProcPtr)(short item, DialogPtr theDialog);
  130. typedef pascal Boolean (*FileFilterProcPtr)(ParmBlkPtr PB);
  131.  
  132. /* the following also include an extra parameter of "your data pointer" */
  133. typedef pascal short (*DlgHookYDProcPtr)(short item, DialogPtr theDialog, void *yourDataPtr);
  134. typedef pascal Boolean (*ModalFilterYDProcPtr)(DialogPtr theDialog, EventRecord *theEvent, short *itemHit, void *yourDataPtr);
  135. typedef pascal Boolean (*FileFilterYDProcPtr)(ParmBlkPtr PB, void *yourDataPtr);
  136. typedef pascal void (*ActivateYDProcPtr)(DialogPtr theDialog, short itemNo, Boolean activating, void *yourDataPtr);
  137.  
  138. typedef OSType SFTypeList[4];
  139.  
  140. #ifdef __cplusplus
  141. extern "C" {
  142. #endif
  143. pascal void SFPutFile(Point where,
  144.                       ConstStr255Param prompt,
  145.                       ConstStr255Param origName,
  146.                       DlgHookProcPtr dlgHook,
  147.                       SFReply *reply)
  148.  = {0x3F3C,0x0001,0xA9EA}; 
  149.  
  150. pascal void SFGetFile(Point where,
  151.                       ConstStr255Param prompt,
  152.                       FileFilterProcPtr fileFilter,
  153.                       short numTypes,
  154.                       SFTypeList typeList,
  155.                       DlgHookProcPtr dlgHook,
  156.                       SFReply *reply)
  157.  = {0x3F3C,0x0002,0xA9EA}; 
  158.  
  159. pascal void SFPPutFile(Point where,
  160.                        ConstStr255Param prompt,
  161.                        ConstStr255Param origName,
  162.                        DlgHookProcPtr dlgHook,
  163.                        SFReply *reply,
  164.                        short dlgID,
  165.                        ModalFilterProcPtr filterProc)
  166.  = {0x3F3C,0x0003,0xA9EA}; 
  167.  
  168. pascal void SFPGetFile(Point where,
  169.                        ConstStr255Param prompt,
  170.                        FileFilterProcPtr fileFilter,
  171.                        short numTypes,
  172.                        SFTypeList typeList,
  173.                        DlgHookProcPtr dlgHook,
  174.                        SFReply *reply,
  175.                        short dlgID,
  176.                        ModalFilterProcPtr filterProc)
  177.  = {0x3F3C,0x0004,0xA9EA}; 
  178.  
  179. pascal void StandardPutFile(ConstStr255Param prompt,
  180.                             ConstStr255Param defaultName,
  181.                             StandardFileReply *reply)
  182.  = {0x3F3C,0x0005,0xA9EA}; 
  183.  
  184. pascal void StandardGetFile(FileFilterProcPtr fileFilter,
  185.                             short numTypes,
  186.                             SFTypeList typeList,
  187.                             StandardFileReply *reply)
  188.  = {0x3F3C,0x0006,0xA9EA}; 
  189.  
  190. pascal void CustomPutFile(ConstStr255Param prompt,
  191.                           ConstStr255Param defaultName,
  192.                           StandardFileReply *reply,
  193.                           short dlgID,
  194.                           Point where,
  195.                           DlgHookYDProcPtr dlgHook,
  196.                           ModalFilterYDProcPtr filterProc,
  197.                           short *activeList,
  198.                           ActivateYDProcPtr activateProc,
  199.                           void *yourDataPtr)
  200.  = {0x3F3C,0x0007,0xA9EA}; 
  201.  
  202. pascal void CustomGetFile(FileFilterYDProcPtr fileFilter,
  203.                           short numTypes,
  204.                           SFTypeList typeList,
  205.                           StandardFileReply *reply,
  206.                           short dlgID,
  207.                           Point where,
  208.                           DlgHookYDProcPtr dlgHook,
  209.                           ModalFilterYDProcPtr filterProc,
  210.                           short *activeList,
  211.                           ActivateYDProcPtr activateProc,
  212.                           void *yourDataPtr)
  213.  = {0x3F3C,0x0008,0xA9EA}; 
  214.  
  215. void sfpputfile(Point *where,char *prompt,char *origName,DlgHookProcPtr dlgHook,
  216.  SFReply *reply,short dlgID,ModalFilterProcPtr filterProc); 
  217. void sfgetfile(Point *where,char *prompt,FileFilterProcPtr fileFilter,short numTypes,
  218.  SFTypeList typeList,DlgHookProcPtr dlgHook,SFReply *reply); 
  219. void sfpgetfile(Point *where,char *prompt,FileFilterProcPtr fileFilter,
  220.  short numTypes,SFTypeList typeList,DlgHookProcPtr dlgHook,SFReply *reply,
  221.  short dlgID,ModalFilterProcPtr filterProc); 
  222. void sfputfile(Point *where,char *prompt,char *origName,DlgHookProcPtr dlgHook,
  223.  SFReply *reply); 
  224.  
  225. /* 
  226.  
  227.   New StandardFile routine comments:
  228.  
  229.   activeList is pointer to array of integer (16-bits).
  230.   first integer is length of list.
  231.   following integers are possible activatable DITL items, in
  232.   the order that the tab key will cycle through.  The first
  233.   in the list is the item made active when dialog is first shown.
  234.  
  235.   activateProc is a pointer to a procedure like:
  236.  
  237.    PROCEDURE MyActivateProc(theDialog:  DialogPtr;
  238.           itemNo:  INTEGER;
  239.           activating: BOOLEAN;
  240.           yourDataPtr: Ptr);
  241.  
  242.   The activateProc is called with activating=FALSE on the itemNo
  243.   about to deactivate then with activating=TRUE on the itemNo
  244.   about to become the active item. (like activate event)
  245.  
  246.   yourDataPtr is a nice little extra that makes life easier without
  247.   globals.  CustomGetFile & CustomPPutFile when calling any of their
  248.   call back procedures, pushes the extra parameter of yourDataPtr on
  249.   the stack.
  250.  
  251.   In addition the filterProc in CustomGetFile & CustomPPutFile is called
  252.   before before SF does any mapping, instead of after.
  253. */
  254.  
  255.  
  256. #ifdef __cplusplus
  257. }
  258. #endif
  259.  
  260. #endif
  261.